POST api/report/loans/{authenticationToken}

This method is used to return a loan report based on a list of loan keys.

Request Information

URI Parameters

Name	Description	Type	Additional information
authenticationToken	Current authentication token	string	Required

Body Parameters

Identifies an explicit list of desired loans.

ReportKeysModel

Name	Description	Type	Additional information
LoanKeys	This is a list of individual loan keys that are to be returned in the loan report. If there are no valid entries in this list, then all loans will be returned in the report.	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "LoanKeys": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ReportKeysModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicAPI.Models">
  <LoanKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </LoanKeys>
</ReportKeysModel>

application/x-www-form-urlencoded

Sample:

LoanKeys=value

Response Information

Resource Description

A report of desired loans.

Collection of ReportModel

Name	Description	Type	Additional information
LoanKey	This property is the internal loan key for the loan.	string	None.
LoanId	This property is the public loan identifier (loan number) for the loan.	string	None.
DateTimeCreated	This property is the date and time the loan was created.	date	None.
StatusAlias	This is the status alias (short description) for the status currently on the loan.	string	None.
StatusDescription	This property is the full status description for the status currently on the loan.	string	None.
StatusDateTime	This property is the date and time the loan was moved to the current status.	date	None.
DateLastModified		date	None.
IsCompleted	This property indicates whether the loan's current status is a "completed" or "final" status.	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "LoanKey": "sample string 1",
    "LoanId": "sample string 2",
    "DateTimeCreated": "2025-07-07T03:46:20.0352707-05:00",
    "StatusAlias": "sample string 4",
    "StatusDescription": "sample string 5",
    "StatusDateTime": "2025-07-07T03:46:20.0352707-05:00",
    "DateLastModified": "2025-07-07T03:46:20.0352707-05:00",
    "IsCompleted": true
  },
  {
    "LoanKey": "sample string 1",
    "LoanId": "sample string 2",
    "DateTimeCreated": "2025-07-07T03:46:20.0352707-05:00",
    "StatusAlias": "sample string 4",
    "StatusDescription": "sample string 5",
    "StatusDateTime": "2025-07-07T03:46:20.0352707-05:00",
    "DateLastModified": "2025-07-07T03:46:20.0352707-05:00",
    "IsCompleted": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfReportModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicAPI.Models">
  <ReportModel>
    <DateLastModified>2025-07-07T03:46:20.0352707-05:00</DateLastModified>
    <DateTimeCreated>2025-07-07T03:46:20.0352707-05:00</DateTimeCreated>
    <IsCompleted>true</IsCompleted>
    <LoanId>sample string 2</LoanId>
    <LoanKey>sample string 1</LoanKey>
    <StatusAlias>sample string 4</StatusAlias>
    <StatusDateTime>2025-07-07T03:46:20.0352707-05:00</StatusDateTime>
    <StatusDescription>sample string 5</StatusDescription>
  </ReportModel>
  <ReportModel>
    <DateLastModified>2025-07-07T03:46:20.0352707-05:00</DateLastModified>
    <DateTimeCreated>2025-07-07T03:46:20.0352707-05:00</DateTimeCreated>
    <IsCompleted>true</IsCompleted>
    <LoanId>sample string 2</LoanId>
    <LoanKey>sample string 1</LoanKey>
    <StatusAlias>sample string 4</StatusAlias>
    <StatusDateTime>2025-07-07T03:46:20.0352707-05:00</StatusDateTime>
    <StatusDescription>sample string 5</StatusDescription>
  </ReportModel>
</ArrayOfReportModel>